package com.gsy.config;


import com.github.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapUI;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.*;

/**
 * swagger2的配置文件，在项目的启动类的同级文件建立
 */
@Configuration
@EnableSwagger2
@EnableSwaggerBootstrapUI
public class Swagger2 {

    @Value("${swagger.is.enable}")
    private boolean swagger_is_enable;

    @Value("${server.url}")
    private String serverUrl;

    // swagger2的配置文件，这里可以配置swagger2的一些基本的内容，比如扫描的包等等

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .enable(swagger_is_enable)
                .globalOperationParameters(globalOperationParameters())
                .useDefaultResponseMessages(false)
                .pathMapping("/")
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.gsy.controller"))
                .paths(PathSelectors.any()).build()
                .apiInfo(apiInfo())
                // 为当前包路径
                ;
    }
    /**
     * 所有请求都添加的统一参数(或者头)信息
     * @return
     */
    private List<Parameter> globalOperationParameters() {
        List<Parameter> pars = new ArrayList<>();
        pars.add(new ParameterBuilder().name("Content-Type").defaultValue("application/json;charset=UTF-8").description("哈")
                .hidden(false).parameterType("header").modelRef(new ModelRef("string")).build());
        return pars;
    }
    // 构建 api文档的详细信息函数,注意这里的注解引用的是哪个
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 页面标题
                .title("在线api文档")
                // 创建人
                .contact(new Contact("admin",
                        "http" + "://" + serverUrl
                                + "/swagger-ui.html",
                        "aaa868@163.com"))
                // 版本号
                .version("1.0")
                .license("The Apache License")
                // 描述
                .description("提供用户平台管理等接口").build();
    }
}
